package org.dromara.demo.controller;

import lombok.Data;
import org.dromara.common.core.domain.R;
import org.dromara.common.sensitive.annotation.Sensitive;
import org.dromara.common.sensitive.core.SensitiveStrategy;
import org.dromara.common.web.core.BaseController;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


/**
 * @Author 刘武贵
 * @Date 2024/8/15 22:00
 * @Description 功能描述：测试数据脱敏控制器
 * <p>
 * 默认管理员不过滤
 * 需自行根据业务重写实现
 *
 */
@RestController
@RequestMapping("/demo/sensitive")
public class TestSensitiveController extends BaseController {

    /**
     * 测试数据脱敏
     * 测试接口，用于返回包含敏感信息的测试对象
     * 此接口主要用于演示或测试目的，展示如何在控制器中处理和返回模拟的敏感数据
     *
     * @return 返回一个包含个人敏感信息的TestSensitive对象
     */
    @GetMapping("/test")
    public R<TestSensitive> test() {
        TestSensitive testSensitive = new TestSensitive();
        testSensitive.setIdCard("210397198608215431");
        testSensitive.setPhone("17640125371");
        testSensitive.setAddress("北京市朝阳区某某四合院1203室");
        testSensitive.setEmail("17640125371@163.com");
        testSensitive.setBankCard("6226456952351452853");
        return R.ok(testSensitive);
    }

    @Data
    static class TestSensitive {

        /**
         * 身份证
         * 定义一个私有的字符串变量，用于存储身份证号信息
         * 使用@Sensitive注解，标记该字段包含敏感信息，策略为ID_CARD，表示身份证号需要进行脱敏处理
         */
        @Sensitive(strategy = SensitiveStrategy.ID_CARD)
        private String idCard;

        /**
         * 电话
         * 采用PHONE策略进行脱敏，适用于所有普通角色
         */
        @Sensitive(strategy = SensitiveStrategy.PHONE, roleKey = "common")
        private String phone;

        /**
         * 地址
         * 采用地址加密策略，并限定系统用户查询权限
         * 该注释解释了为什么需要这样处理：为了保护用户隐私和数据安全
         */
        @Sensitive(strategy = SensitiveStrategy.ADDRESS, perms = "system:user:query")
        private String address;

        /**
         * 邮箱
         * 该字段用于存储用户的电子邮件地址
         * 对电子邮件地址进行脱敏处理，策略为EMAIL，适用于通用角色，权限为system:user:query
         */
        @Sensitive(strategy = SensitiveStrategy.EMAIL, roleKey = "common", perms = "system:user:query1")
        private String email;

        /**
         * 银行卡
         * 该注释说明了方法或字段具有敏感性，并定义了敏感信息的处理策略
         * 具体来说，Sensitive注解指定了处理策略为银行卡号（SensitiveStrategy.BANK_CARD）
         * 同时，它关联了一个角色键（roleKey）"common1"，表示只有拥有该角色的用户才有权限访问此敏感信息
         * 另外，注解中的perms属性指定了权限字符串，表示系统用户查询操作的权限
         * 综上，该注释用于细致地控制和处理银行卡号这类敏感信息的访问权限
         */
        @Sensitive(strategy = SensitiveStrategy.BANK_CARD, roleKey = "common1", perms = "system:user:query")
        private String bankCard;

    }

}
